<meta charset="utf-8">
(#) Affected by scoped storage

!!! WARNING: Affected by scoped storage
   This is a warning.

Id
:   `ScopedStorage`
Summary
:   Affected by scoped storage
Severity
:   Warning
Category
:   Correctness
Platform
:   Android
Vendor
:   Android Open Source Project
Feedback
:   https://issuetracker.google.com/issues/new?component=192708
Since
:   4.1.0 (October 2020)
Affects
:   Manifest files
Editing
:   This check runs on the fly in the IDE editor
See
:   https://goo.gle/android-storage-usecases
Implementation
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/ScopedStorageDetector.kt)
Tests
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/ScopedStorageDetectorTest.kt)

Scoped storage is enforced on Android 10+ (or Android 11+ if using
`requestLegacyExternalStorage`). In particular, `WRITE_EXTERNAL_STORAGE`
will no longer provide write access to all files; it will provide the
equivalent of `READ_EXTERNAL_STORAGE` instead.

As of Android 13, if you need to query or interact with MediaStore or
media files on the shared storage, you should be using instead one or
more new storage permissions:
* `android.permission.READ_MEDIA_IMAGES`
* `android.permission.READ_MEDIA_VIDEO`
* `android.permission.READ_MEDIA_AUDIO`

and then add `maxSdkVersion="33"` to the older permission. See the
developer guide for how to do this:
https://developer.android.com/about/versions/13/behavior-changes-13#granular-media-permissions

The `MANAGE_EXTERNAL_STORAGE` permission can be used to manage all
files, but it is rarely necessary and most apps on Google Play are not
allowed to use it. Most apps should instead migrate to use scoped
storage. To modify or delete files, apps should request write access
from the user as described at
https://goo.gle/android-mediastore-createwriterequest.

To learn more, read these resources: Play policy:
https://goo.gle/policy-storage-help Allowable use cases:
https://goo.gle/policy-storage-usecases.

!!! Tip
   This lint check has an associated quickfix available in the IDE.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
AndroidManifest.xml:4:Warning: WRITE_EXTERNAL_STORAGE no longer provides
write access when targeting Android 10, unless you use
requestLegacyExternalStorage [ScopedStorage]
    &lt;uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/&gt;&lt;!-- ERROR --&gt;
                                   -----------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`AndroidManifest.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
&lt;manifest xmlns:android="http://schemas.android.com/apk/res/android" package="test.pkg"&gt;
    &lt;uses-sdk android:targetSdkVersion="29"/&gt;
    &lt;uses-permission/&gt;&lt;!-- Test for NPEs --&gt;
    &lt;uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/&gt;&lt;!-- ERROR --&gt;
    &lt;uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/&gt;&lt;!-- OK --&gt;
&lt;/manifest&gt;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/ScopedStorageDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `ScopedStorageDetector.testWriteExternalStorage`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=192708.

(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Adding the suppression attribute `tools:ignore="ScopedStorage"` on
  the problematic XML element (or one of its enclosing elements). You
  may also need to add the following namespace declaration on the root
  element in the XML file if it's not already there:
  `xmlns:tools="http://schemas.android.com/tools"`.

  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;manifest xmlns:tools="http://schemas.android.com/tools"&gt;
      ...
      &lt;uses-permission tools:ignore="ScopedStorage" .../&gt;
    ...
  &lt;/manifest&gt;
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="ScopedStorage" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'ScopedStorage'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore ScopedStorage ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>